Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Original tutorial plus custom rendering part 1, initial draft #3

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

leprechaunt33
Copy link

This is an initial commit of content partially from the conversion provided on the Discord of my original PDF tutorial, with slight changes to order, content and formatting.

The pull request contains icons of the hotham logo, the Vulkan logo, and my own attribution logo formatted to ensure they are no more than 60px in height to appear as unobtrusive as possible within the mdbook format introduction.

It also contains two images lifted directly from the Open XR specification which specifically do nothing but specify the axes conventions for input and graphics, as well as one screenshot to illustrate the properties of the example objects being discussed in the initial several pages. I do not believe there are any copyright concerns in referencing the axes convention images, but if there are feel free to remove them.

No compilation instructions from the original tutorial are included as yet as it is preferable that the capabilities of mdBook format are exploited (ie handlebars) to allow the dynamic creation of a shell script or PS1 for the target OS to set all relevant cross compilation environment variables and so on.

No source code is yet provided for the custom rendering example, only general considerations to be made as well as an explanation of how the primary two sets of shaders/pipelines work together.

Opening this to criticism on presentation/grammar or overlooked points. I intend on looking at example source code for the custom rendering following this PR.

Initial introduction, models, coordinate systems and transformations.
- Added prior tutorial content converted  from pdf
- Added code blocks from dynamic texturing example
- Added content to Getting Started to show interaction with openxr for available extensions, and EngineBuilder pattern
- Added Systems and Colliders into the SUMMARY page.
- Described all systems called within the tick function
- Added brief information about colliders
- Added additional context within the drawing text example on usage of the example code and speed
- Add custom rendering link within summary page
- Minor grammatical and visual fixes in introduction
- Full discussion of considerations for custom rendering prior to providing sample code.
Vulkan and Render Context content added.  Custom Rendering sections to be adjusted significantly in next push
loading models: added mention of additional path related functions within native activity
getting started: minor formatting adjustments
conclusion: resources added, conclusion to be added subsequently.
custom rendering: parts 1 and 2 adjusted, parts 3 and 4 added covering swapchain images, culling and pipeline barriers.  Section 4 to be updated subsequently with sample code.
Added code to tie prior sections together and conclusion
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant